InvokeThingService_物联网平台_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.

接口说明

使用说明

定义产品物模型服务时,已设置服务调用方式。因此,调用本接口时,物联网平台会根据请求参数 Identifier 值,选择服务对应的调用方式。

  • 同步方式:物联网平台直接使用 RRPC 同步方式下行推送请求,设备返回 RRPC 响应消息。RRPC 使用详情,请参见什么是 RRPC
  • 异步方式:物联网平台采用异步方式下行推送请求,设备采用异步方式返回结果。订阅的 Topic 详情,请参见设备服务调用

注意 若创建产品时,设置物模型校验类型为免校验,调用本接口会默认为异步调用方式。

调用服务到设备端后,设备会返回调用结果给接口的调用方。设备端响应逻辑及响应结果,需您在设备端完成开发。设备返回结果的数据格式必须符合标准的 Alink 协议,Alink JSON 格式如下:

{
	"id": "58***89",
	"code": 200,
	"data": {},
	"message": "success",
	"localizedMsg": "localizedMsg"
}
说明
  • id 为物联网平台生成的唯一 ID,设备从服务调用请求中获取,并原文返回。
    • code 为整型数字,会返回给接口调用方,用于判断服务调用结果。
    • data 为调用设备服务的结果数据,会返回给接口调用方。数据必须为 JSON 格式,由用户自行定义返回内容。
    • messagelocalizedMsg 根据业务需要进行返回。 例如物联网平台的设备接入 C Link SDK 提供了物模型使用示例,详细内容,请参见调用服务

    使用限制

    同步调用服务,最大超时时间为 8 秒。若 8 秒内服务器未收到回复,则返回超时错误。异步调用服务无最大超时时间限制。

    QPS 限制

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

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

    流控信息

    当前云产品API请求速率暂未透出。

    授权信息

    当前云产品暂无权限信息透出。

    请求参数

    字段名称字段详情
    IotInstanceIdstring

    实例 ID。您可在物联网平台控制台的实例概览页面,查看当前实例的 ID展开详情

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

    要调用服务的设备所属的产品 ProductKey。展开详情

    示例值:a1BwAGV****参考取值来源:
      CreateProduct
      QueryProductList
      ReleaseProduct
      ListProductByTags
      BindLicenseProduct
      BatchBindProductsIntoProject
    DeviceNamestring

    要调用服务所属设备的 DeviceName。展开详情

    示例值:light
    Identifierstring

    服务的标识符。展开详情

    示例值:Set
    Argsstring

    要启用服务的入参信息,数据格式为 JSON String,例如Args={"param1":1}展开详情

    示例值:{"param1":1}
    IotIdstring

    要调用服务的设备 ID。物联网平台为该设备颁发的 ID,设备的唯一标识符。展开详情

    示例值:Q7uOhVRdZRRlDnTLv****00100
    Qosinteger<int32>
    取值 <= 1

    请求说明

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

    返回参数

    字段名称字段详情
    Codestring

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

    示例值:iot.system.SystemException
    RequestIdstring

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

    示例值:E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565
    ErrorMessagestring

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

    示例值:系统异常
    Successboolean

    是否调用成功。展开详情

    示例值:true
    Dataobject

    调用成功时,返回的数据。

    返回示例

    变更历史

    暂无变更历史