管理API
例如描述API返回的数据，API的应用场景。路径 路径为API调用地址的组成部分。路径只能以/开头，仅支持以英文、数字、下划线（_）、横杠（-）组成，例如/item/add。API调用地址结构示例：https://{分组域名}{路径}。路径定义为/item/test、...
通过向导模式创建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即...
GetDataServiceApi
ResponseContentType Integer 0 API的返回数据类型，可选枚举值包括0（JSON）和1（XML）。向导和脚本API支持JSON，注册API支持JSON和XML。CreatorId String 1234567 创建人的阿里云ID。VisibleRange Integer 0 可见范围，可选枚举值包括0...
GetDataServicePublishedApi
ResponseContentType Integer 0 API的返回数据类型，可选枚举值包括0（JSON）和1（XML）。向导和脚本API支持JSON，注册API支持JSON和XML。CreatorId String 1234567 创建人的阿里云ID。VisibleRange Integer 0 可见范围，可选枚举值包括0...
数据分析
接口 单击 数据API，选择 物联网数据分析 中基于上报设备信息所生成的数据API。支持类型：通用接口：官方提供的数据分析公开API。例如：统计租户下设备的数量。用户接口：数据服务中自定义的API。旧版公共实例：通过 数据分析>分析透视>SQL...
返回结果
不同的 API 请求返回的数据内容和格式不同，请查阅 写入数据 和 读取数据。请求失败 如果错误发生，API 将为各个错误返回一个对应格式化的 JSON 对象。该对象包含的字段如下表所示：字段名 类型 是否必选 描述 举例 code Integer Yes HTTP ...
测试与发布API
返回条数 用于定义测试API时返回数据的条数：如果请求方式为LIST，则支持选择 返回条数，最大可返回10000条数据。请求方式为GET，不支持修改 返回条数。配置完成后，单击 测试 进行测试API与数据源数据的连通性。单击 查看脚本，支持查看...
ListDataServicePublishedApis
ScriptResponseParameters Array of ScriptResponseParameter 脚本API返回参数列表 ParameterDescription String description2 描述 ParameterName String param2 参数名称 ExampleValue String example2 示例值 ParameterDataType Integer...
ListDataServiceApis
ResponseContentType Integer 0 API的返回数据类型，可选枚举值包括0（JSON）和1（XML）。向导和脚本API支持JSON，注册API支持JSON和XML。CreatorId String 1234567 创建人的阿里云ID。VisibleRange Integer 0 可见范围，可选枚举值包括0...
模型管理
这样可以增强用户传入参数的便利性，同时可以方便用户反序列化返回的数据。API网关模型定义基于 JSON架构草案4 的规范，但存在一定的条件限制：1.仅支持创建元素属性为Object类型的JSON Schema；2.$ref仅支持本用户的内部Model引用。Model...
产品数据API
返回类型 调用API后，返回数据的格式，固定为JSON。在 配置参数并测试 页面，修改以下配置参数和高级设置。类别 配置项 说明 配置参数 请求参数 单击 添加参数，选择可添加的 绑定字段。添加的参数支持设置操作符、是否必填、示例值和参数...
功能优势
查询性能与用户查询返回的数据大小成反比，即查询返回的数据越多，性能损耗相应增加。支持用户指定密钥，且服务结束时自动销毁 用户可以任意选择己方信任的已有或者第三方密钥管理服务，获取密钥后，动态传递给全密态客户端（例如传参）。...
查看计量详情
查看监控图表 API网关状态码 API网关状态码图表展示了在某段时间内，调用API所返回的各类API网关状态码数目的变化趋势。数据服务错误码 数据服务错误码图表展示了在某段时间内，调用API所返回的各类数据服务错误码数目的变化趋势，可以帮助...
概述
当应用程序通过规则中指定的账号连接至数据库并查询规则中指定的列时，Proxy会先将数据库返回的数据脱敏转换，再将脱敏后的数据返回给客户端。上图的脱敏规则为：仅当使用 testAcc 账号连接数据库进行查询时生效。仅对查询结果中 name 和 ...
DataWorks数据服务对接DataV最佳实践
由于API返回的日期格式与组件默认的格式不一样，此时的折线图并没有正确展示，您还需要设置折线横轴的日期格式。切换至配置面板，在 x轴>轴标签 中选择数据种类为 时间型，数据格式选择本API所返回的格式2016/01/01，即可看见折线图的正常...
自定义服务API
返回类型 调用API后，返回数据的格式，固定为JSON。在 配置参数并测试 页面，完成以下配置。类别 配置项 说明 数据来源 指标 选择具体 指标域 和 数据集。数据集 是指标域的具体对象组织，例如产品域下具体产品，设备域下具体设备。指标...
SQL窗口介绍
查询数据库返回的数据行。自由操作和稳定变更模式的数据库默认返回行数为3000行（上限）。安全协同模式数据库默认返回行数为200行，系统规定查询返回行数上限为3000行。若需要调整查询返回的行数，可由管理员在 安全与规范>安全规则>SQL...
注意事项
DataV组件要求的数据格式是个数组，数据服务生成的API返回结果是个带有错误码的完整JSON，因此要使用过滤器对API结果进行处理。您可以在DataV中添加过滤器，也可以直接在数据服务配置API时添加过滤器。一般来说，对于未分页查询的API，直接...
API调用特殊参数说明
true return_lower_case 返回数据转小写 true 使用示例 使用第三方工具调用“查询银行客户信息”API，返回的原始数据如下：期望按照分页的方式获取数据，每页返回5条数据，并且每条数据中只包含zzhm（证件号码）、khmc（客户名称）、yddh1...
教程概述
本文为您介绍当需要通过DataV展示海量数据的分析结果时，如何使用DataWorks的数据服务开发数据API，并快速在DataV中调用API，最终将来自MaxCompute的数据成果展示在DataV大屏中，数据开发到数据服务再到数据分析展现一气呵成。注意 本案例...
AbolishDataServiceApi
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 AbolishDataServiceApi 系统规定参数。取值：...
创建单物理表服务单元
后续您可以基于该单物理表服务单元开发访问该物理表数据的API。本文为您介绍如何创建单物理表服务单元。前提条件 已完成服务单元分组的创建。具体操作，请参见 创建服务项目分组。当数据源类型为Hbase 0.9.4/1.1.x/1.2.1/2.x、...
创建多物理表服务单元
后续您可以基于该多物理表服务单元开发可以同时访问多物理表数据的API，以实现联合数据查询。本文为您介绍如何创建多物理表服务单元。前提条件 已完成服务单元分组的创建。具体操作，请参见 创建服务项目分组。当数据源类型为Hbase 0.9.4/1...
PublishDataServiceApi
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 PublishDataServiceApi 系统规定参数。取值：...
功能简介
流式数据服务的源头为DataHub或RocketMQ的Topic，服务封装为DataHub Topic的读取API，返回Topic中的数据。数据源可以是DataHub和RocketMQ。批量离线数据服务的源头为MaxCompute的数据表，服务封装为根据分区获取分区内全部数据的API。非...
统一服务
流式数据服务的源头为DataHub或RocketMQ的Topic，服务封装为DataHub Topic的读取API，返回Topic中的数据。数据源可以是DataHub和RocketMQ。批量离线数据服务的源头为MaxCompute的数据表，服务封装为根据分区获取分区内全部数据的API。非...
DeleteDataServiceApi
调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 DeleteDataServiceApi 系统规定参数。取值：...
按应用关联
根据应用关联对应资源信息，选中目标应用后，系统自动选中关联此应用的上线API、有产出关系的场景、场景下包含的所有场景节点以及场景节点包含的所有逻辑表以及数据标准、数据源和全局配置。说明 工作组若有创建数据标准、数据源和全局变量...
DescribeHistoryApis-查询API发布版本定义列表
查询API历史发布版本列表。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。...变更历史 变更时间 变更内容概要 操作 2024-03-21 OpenAPI 返回结构发生变更 看变更集 变更项 变更内容 出参 OpenAPI 返回结构发生变更。
DescribeDeployedApis-查询已发布 API 列表
接口说明 此功能面向开放 API 的用户 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。调试 授权信息 下表是API对应的授权信息，可以在RAM权限策略语句的 ...
功能简介
流式数据服务的源头为DataHub或RocketMQ的Topic，服务封装为DataHub Topic的读取API，返回Topic中的数据。数据源可以是DataHub和RocketMQ。批量离线数据服务的源头为MaxCompute的数据表，服务封装为根据分区获取分区内全部数据的API。非...
导入导出 API
您可以在 API 网关控制台上以 JSON 文件的形式对 API 进行批量导入及导出。说明 为减少操作耗时，建议一次性导入/导出 API 的数量不超过 100 个。导入 API 的 JSON 格式请参见模板 API Json 文件格式。批量导出 API 在 API 发布>API 管理 ...
按线上API关联
根据已上线的API（服务）关联对应资源信息，手动选中目标服务后，系统自动选中API的归属应用、和API关联的物理表、和API关联物理表有产出关系的场景、场景下包含的所有场景节点、场景下输出的物理表，以及场景节点包含的所有逻辑表，以及...
DescribeApisByBackend-根据后端查询 API 列表
1 ApiInfoList object[]返回的 API 列表信息 ApiId string API 的 ID 20bcdc9453524b78a8beb1f6de21edb7 Description string API 的描述信息 test GroupName string api 分组名称 testApiGroup GroupId string api 分组 ID 15bcdc9453524b7...
DescribeApiProductApis-查询API产品绑定的API列表
返回的 API 列表信息 ApiId string API 的 ID dd46297680014a7e8e318308f3345951 Description string API 的描述信息 test GroupName string api 分组名称 testApiGroup GroupId string api 分组 ID 1e377f18142345dfb700cd8911c2463a Path...
ModifyApi-修改API定义
接口说明"此接口面向开放 API 的用户 该接口需要全量更新，不支持部分参数更新 修改 ApiName 时需要注意，同一个分组内 API 不允许重名 修改 RequestPath 时需要注意，同一个分组内 Path 不允许重复 该接口调用的 QPS 限制为：单用户 QPS ...
CreateApi-创建 API
接口说明 此接口面向开放 API 的用户。同一个分组内 API 不允许重名。同一个分组内 Path 不允许重复。该接口调用的 QPS 限制为：单用户 QPS 不超过 50。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后...
- 产品推荐
- 这些文档可能帮助您