CreateDataAPIService_物联网平台_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

限制条件

单阿里云账号调用该接口的每秒请求数(QPS)最大限制为 1。

说明 RAM 用户共享阿里云账号配额。

流控信息

请求速率为500/1(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
iot:CreateDataAPIService
Create
全部资源
*

请求参数

字段名称字段详情
RequestParamarray<object>

请求参数列表。

子级条数 <= 100
ResponseParamarray<object>

响应参数列表。

子级条数 <= 100
DisplayNamestring

API 的显示名称,需具有全局唯一性。仅支持中文汉字、英文字母、数字、下划线(_)、连接符(-)、英文圆括号和空格,长度不超过 20 个字符。

示例值:查询设备总数
OriginSqlstring

API 对应的原始 SQL,指定数据开发的 SQL 样式。展开详情

示例值:SELECT COUNT(iot_id) AS deviceCount FROM ${system.device} WHERE status=1
Descstring

API 的描述。

示例值:数据分析API
TemplateSqlstring

服务的模板 SQL,即原始 SQL 的模板化。展开详情

示例值:SELECT COUNT(iot_id) AS deviceCount FROM ${system.device} WHERE status=${status}
ApiPathstring

API 调用地址的自定义部分。作为 API 资源标识符,需具有全局唯一性。展开详情

示例值:device/getDeviceCountByStatus
IotInstanceIdstring

实例 ID。公共实例不传此参数,企业版实例需传入。

示例值:iot_instc_pu****_c*-v64********

请求说明

调用 API 时,除了本文介绍的该 API 的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回参数

字段名称字段详情
Codestring

调用失败时,返回的错误码。更多信息,请参见错误码

示例值:Success
ErrorMessagestring

调用失败时,返回的出错信息。

示例值:请求参数错误
RequestIdstring

阿里云为该请求生成的唯一标识符。

示例值:57b144cf-09fc-4916-a272-a62902d5b207
Successboolean

表示是否调用成功。展开详情

示例值:true
Dataobject

调用成功时,返回注册的设备信息。

返回示例

变更历史

暂无变更历史

相关示例

物联网平台/数据分析/数据API (https://iot.console.aliyun.com/la/home)
2022-06-10