QueryDeviceInfo_物联网平台_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 限制

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

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

流控信息

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

授权信息

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

具体说明如下:展开详情

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

请求参数

字段名称字段详情
IotInstanceIdstring

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

示例值:iot-v64***
ProductKeystring

要查询设备所属产品的 ProductKey。展开详情

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

要查询设备的设备名称。展开详情

示例值:light
IotIdstring

要查询设备的设备 ID。展开详情

示例值:Q7uOhVRdZRRlDnTLv****00100

请求说明

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

返回参数

字段名称字段详情
Codestring

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

示例值:iot.system.SystemException
ErrorMessagestring

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

示例值:系统异常
RequestIdstring

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

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

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

示例值:true
Dataobject

调用成功时,返回设备的基本信息。

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
Iot.Device.NotExistedDevice
The device does not exist.诊断
400
Iot.common.QueryDeviceActionError
An error occurred while querying the device.诊断
400
iot.device.InvalidFormattedDeviceNameInNameArray
The DeviceName list contains an invalid DeviceName.诊断
400
iot.common.InvalidTenant
The tenant is invalid.诊断
400
iot.device.InvalidFormattedDeviceName
The DeviceName format is invalid.诊断
400
Iot.digitaltwin.DTInstanceInvalidThingType
The digital twin operation is not supported.诊断
400
iot.gateway.BackEndServiceInvalid
Request has failed due to invalid backend server诊断
400
Iot.device.InvalidIoTId
The specified device ID is invalid.诊断
400
iot.device.NullDeviceName
The deviceName is empty.诊断
400
iot.device.DeviceInstanceInconsistency
The instance of devices is inconsistency.诊断
400
iot.prod.NotExistedProduct
The specified product does not exist.诊断
400
iot.prod.NullProductKey
The productKey is empty.诊断
400
iot.common.QueryDevicePropertyActionError
An error occurred while querying the device property.诊断
400
iot.common.QueryManyDevicesActionError
An error occurred while querying the devices诊断
400
iot.Sre.IotInstanceStatusForbidden
Instance status forbidden.诊断

变更历史

暂无变更历史

相关示例

一型一密免注册功能
2022-07-06