通过向导模式创建API（服务单元）
数据更新频率 定义API返回数据的更新频率，选择 每天、每小时 或 每分钟 更新API返回的数据，便于调用方了解数据的时效性。API分组 选择当前项目下配置的API分组，如需创建，请参见 创建服务分组。描述 填写对API简单的描述。不超过128字符...
通过向导模式创建API（Dataphin表）
数据更新频率 定义API返回数据的更新频率，选择 每天、每小时 或 每分钟 更新API返回的数据，便于调用方了解数据的时效性。API分组 选择当前项目下配置的API分组，如需创建，请参见 创建服务分组。描述 填写对API简单的描述。不超过128字符...
通过SQL模式创建API（Dataphin表）
数据更新频率 定义API返回数据的更新频率，选择 每天、每小时 或 每分钟 更新API返回的数据。API分组 选择当前项目下配置的API分组，如需创建，请参见 创建服务分组。描述 填写对API简单的描述。不超过128字符。协议 默认选中HTTP。HTTP即...
通过SQL模式创建API（服务单元）
数据更新频率 定义API返回数据的更新频率，选择 每天、每小时 或 每分钟 更新API返回的数据。API分组 选择当前项目下配置的API分组，如需创建，请参见 创建服务分组。描述 填写对API简单的描述。不超过128字符。协议 默认选中HTTP。HTTP即...
使用限制
调用量限制：数据API上限：10万/天/用户/API，如需大量调用请联系客服进行调整。控制台调试API上限：200次/天/用户。区域限制：目前只开通了 华 东2（上 海）区域，其它区域不支持。说明 用户：以阿里云主账号维度进行确认，非子账号或角色...
管理API
例如描述API返回的数据，API的应用场景。路径 路径为API调用地址的组成部分。路径只能以/开头，仅支持以英文、数字、下划线（_）、横杠（-）组成，例如/item/add。API调用地址结构示例：https://{分组域名}{路径}。路径定义为/item/test、...
GetDataServiceApi
ServiceHost String http://example.aliyundoc.com 后端服务地址 ServiceContentType Integer 0 API返回数据类型，可选枚举值：0：JSON 1：XML 向导和脚本API只支持JSON；注册API支持JSON和XML。ServicePath String/index 后端服务路径 ...
测试与发布API
返回条数 用于定义测试API时返回数据的条数：如果请求方式为LIST，则支持选择 返回条数，最大可返回10000条数据。请求方式为GET，不支持修改 返回条数。配置完成后，单击 测试 进行测试API与数据源数据的连通性。单击 查看脚本，支持查看...
GetDataServicePublishedApi
ResponseContentType Integer 0 API的返回数据类型，可选枚举值包括0（JSON）和1（XML）。向导和脚本API支持JSON，注册API支持JSON和XML。CreatorId String 1234567 创建人的阿里云ID。VisibleRange Integer 0 可见范围，可选枚举值包括0...
ListDataServicePublishedApis
返回数据 名称 类型 示例值 描述 HttpStatusCode Integer 200 HTTP状态码。RequestId String 0000-ABCD-EFG*请求ID，一次请求的唯一标识。ErrorMessage String The connection does not exist.错误信息。Success Boolean true 调用是否成功...
ListDataServiceApis
返回数据 名称 类型 示例值 描述 HttpStatusCode Integer 200 HTTP状态码。RequestId String 0000-ABCD-EFG*请求ID，一次请求的唯一标识。ErrorMessage String The connection does not exist.错误信息。Success Boolean true 调用是否成功...
产品数据API
删除参数后，可单击 添加参数，重新添加绑定字段为返回参数，也可选中页面右侧的 选择全部参数 复选框，重新选择所有字段作为API返回参数。说明 用于排序 是指对查询获取的数据根据该字段的值进行排序（升序或降序），排序后再返回查询结果...
数据服务API
详情请参见 测试API，您可以根据 返回示例 的数据内容和数据结构了解API返回结果。血缘信息：您可以查看数据表、API、APP之间的完整血缘关系。数据接口API的上游血缘支持的数据源类型包括：Hologres、MySQL、PostgreSQL、SQL Server、...
使用限制
子查询结果返回数据点数：每个子查询在经过时序聚合计算后，返回到应用层的数据点数量。QPS上限：此处QPS测量的查询基准为以5分钟作为查询的时间范围扫描一条按每10秒上报一条数据的时间线（只含一个Tag的单值数据）的查询 注意事项 单次...
自定义服务API
返回类型 调用API后，返回数据的格式，固定为JSON。在 配置参数并测试 页面，完成以下配置。类别 配置项 说明 数据来源 指标 选择具体 指标域 和 数据集。数据集 是指标域的具体对象组织，例如产品域下具体产品，设备域下具体设备。指标...
返回结果
不同的 API 请求返回的数据内容和格式不同，请查阅 写入数据 和 读取数据。请求失败 如果错误发生，API 将为各个错误返回一个对应格式化的 JSON 对象。该对象包含的字段如下表所示：字段名 类型 是否必选 描述 举例 code Integer Yes HTTP ...
返回结果
调用 API 服务后返回数据采用统一格式：返回的 HTTP 状态码为 2xx，代表调用成功。返回的 HTTP 状态码为 4xx 或 5xx，代表调用失败。调用成功返回的数据格式主要有 XML 和 JSON 两种，外部系统可以在请求时传入参数来制定返回的数据格式，...
DescribeApiTrafficData-查询API监控数据中流量统计...
接口说明 此功能面向开放 API 的用户 监控功能默认对线上环境的 API 做统计，不包括测试环境的 API 调用 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。...
公共参数
接口名称+Response>返回结果 调用API服务后返回数据采用统一格式：返回的 HTTP 状态码为2xx，代表调用成功；返回的 HTTP 状态码为4xx或 5xx，代表调用失败。调用成功返回的数据格式主要有 XML 和 JSON 两种，外部系统可以在请求时传入参数...
公共参数
接口名称+Response>返回结果 调用API服务后返回数据采用统一格式：返回的HTTP状态码为2xx，代表调用成功；返回4xx或5xx的HTTP状态码代表调用失败。调用成功返回的数据格式主要有 XML 和 JSON 两种，外部系统可以在请求时传入参数来制定返回...
创建单物理表服务单元
如果需要查询所有更多数据，您可以在 调用API 的SDK中修改PageSize参数值，以实现查询API时返回更多的数据。如果已有的服务单元与您配置的基础信息相似，则Dataphin会自动为您展示相似服务单元的名称，您可以在服务单元列表中查看该服务...
创建多物理表服务单元
如果需要查询所有更多数据，您可以在 调用API 的SDK中修改PageSize参数值，以实现查询API时返回更多的数据。添加物理表 单击 添加物理表，在 新增物理表 对话框，添加需要读取数据的多个物理表。Dataphin默认将添加的第一个物理表设为主表...
模型管理
API网关通过使用JSON Schema定义模型，用来描述用户API约定数据的组织方式，比如参数或者返回值有哪些字段，这些字段的取值范围等。同时，通过定义模型，并在用户创建的API中加以引用，用户在API的SDK导出时，关联的Model会自动生成对应的...
统一服务
流式数据服务的源头为DataHub或RocketMQ的Topic，服务封装为DataHub Topic的读取API，返回Topic中的数据。数据源可以是DataHub和RocketMQ。批量离线数据服务的源头为MaxCompute的数据表，服务封装为根据分区获取分区内全部数据的API。非...
功能简介
流式数据服务的源头为DataHub或RocketMQ的Topic，服务封装为DataHub Topic的读取API，返回Topic中的数据。数据源可以是DataHub和RocketMQ。批量离线数据服务的源头为MaxCompute的数据表，服务封装为根据分区获取分区内全部数据的API。非...
查看计量详情
API计量详情提供了各类可视化图表及统计数据，可以针对单个API分别查看监控图表，包括API网关状态码、数据服务错误码、App请求次数、流量带宽、平均响应时间。进入计量详情页面 登录 DataWorks控制台，单击左侧导航栏的 数据服务，在下拉框...
功能简介
流式数据服务的源头为DataHub或RocketMQ的Topic，服务封装为DataHub Topic的读取API，返回Topic中的数据。数据源可以是DataHub和RocketMQ。批量离线数据服务的源头为MaxCompute的数据表，服务封装为根据分区获取分区内全部数据的API。非...
使用DataV可视化应用展示数据返回结果
本文为您介绍如何在DataV中调用DataWorks的数据服务API，并将数据返回结果展示在DataV可视化应用中。前提条件 在开始本案例前，您需要首先完成 准备工作，并已经 生成了数据服务API。背景信息 警告 您必须使用HTTP协议进入DataV控制台，...
API错误码（ODPS-04CCCCX）
方案一：不需要查看超过10000行的数据时，在SELECT语句中添加Limit关键字，限制返回数据的行数。例如 select*from sale_detail where region='china' order by total_price limit 3;方案二：解除屏显限制，即可查看超过10000行的数据。更多...
注意事项
DataV组件要求的数据格式是个数组，数据服务生成的API返回结果是个带有错误码的完整JSON，因此要使用过滤器对API结果进行处理。您可以在DataV中添加过滤器，也可以直接在数据服务配置API时添加过滤器。一般来说，对于未分页查询的API，直接...
AbolishDataServiceApi
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 AbolishDataServiceApi 系统规定参数。取值：...
DataWorks数据服务对接DataV最佳实践
DataV组件要求的数据格式是个数组，数据服务生成的API返回结果是带有错误码的完整JSON，因此要使用过滤器对API结果进行处理。您可以选择在DataV中添加过滤器，也可以选择直接在数据服务配置API时添加过滤器。通常对于未分页查询的API，直接...
PublishDataServiceApi
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 PublishDataServiceApi 系统规定参数。取值：...
版本说明
变更时间：2024-04-18 变更集发布说明：OpenAPI 名称 变更内容概要 操作 DescribeAuthorizedApps OpenAPI 返回结构发生变更。查看API变更历史 查看API文档 变更项 变更内容 出参 OpenAPI 返回结构发生变更。变更时间：2024-04-18 变更集...
API调用特殊参数说明
true return_lower_case 返回数据转小写 true 使用示例 使用第三方工具调用“查询银行客户信息”API，返回的原始数据如下：期望按照分页的方式获取数据，每页返回5条数据，并且每条数据中只包含zzhm（证件号码）、khmc（客户名称）、yddh1...
版本说明
变更时间：2024-04-17 变更集发布说明：OpenAPI 名称 变更内容概要 操作 GetProject OpenAPI 返回结构发生变更。查看API变更历史 查看API文档 变更项 变更内容 出参 OpenAPI 返回结构发生变更。变更时间：2024-01-08 变更集发布说明：Open...
添加DataWorks数据服务数据源
本文介绍在DataV中添加DataWorks数据服务数据源，并将通过DataWorks数据表生成的API，快速地展示在DataV可视化大屏中的方法。前提条件 已准备好待添加的DataWorks数据服务数据源。背景信息 DataWorks数据服务生成的API默认不支持HTTPS协议...
独享数据服务资源组
适用场景 需要支持数据服务API的高频率、高并发调用，且需要及时返回数据结果。需要灵活调整资源组大小。需要访问公网、阿里云VPC、IDC网络环境下的数据源。使用限制 独享数据服务资源组的计费方式为包年包月，在资源组到期前不支持提前...
版本说明
变更时间：2024-01-11 变更集发布说明：OpenAPI 名称 变更内容概要 操作 AllocateInstancePublicConnection OpenAPI 返回结构发生变更。查看API变更历史 查看API文档 变更项 变更内容 出参 OpenAPI 返回结构发生变更。...
版本说明
新增入参：EffectiveTime 变更时间：2024-04-22 变更集发布说明：OpenAPI 名称 变更内容概要 操作 DescribeEngineVersion OpenAPI 返回结构发生变更。查看API变更历史 查看API文档 变更项 变更内容 出参 OpenAPI 返回结构发生变更。变更...
- 产品推荐
- 这些文档可能帮助您