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

接口说明

使用说明

调用该接口,单次最多查询到 100 万个设备。

QPS 限制

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

    说明 RAM 用户共享阿里云账号配额。
  • 当请求参数 CurrentPagePageSize 的值相乘结果大于或等于 100,000 时,会降低调用该接口的 QPS。 此时,单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为 2。

流控信息

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

授权信息

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

具体说明如下:展开详情

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

请求参数

字段名称字段详情
IotInstanceIdstring

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

示例值:iot_instc_pu****_c*-v64********
PageSizeinteger<int32>

指定返回结果中每页显示的记录数量,最大值是 50。默认值是 10。

示例值:10
ProductKeystring

要查询的设备所属产品的 ProductKey

示例值:a1BwAGV****参考取值来源:
    CreateProduct
    QueryProductList
    ReleaseProduct
    ListProductByTags
    BindLicenseProduct
    BatchBindProductsIntoProject
CurrentPageinteger<int32>

指定显示返回结果中的第几页的内容。默认值是 1。

示例值:1
NextTokenstring

下一页标识,首次查询无需传入。后续查询需使用的 NextToken,要从上一次查询的返回结果中获取。展开详情

示例值:TGlzdFJlc291cm***

请求说明

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

返回参数

字段名称字段详情
NextTokenstring

下一页标识。可在下次请求时传入,来获取下一页数据。展开详情

示例值:TGlzdFJlc291cm***
ErrorMessagestring

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

示例值:系统异常
RequestIdstring

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

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

是否调用成功。展开详情

示例值:true
Codestring

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

示例值:iot.system.SystemException
PageSizeinteger<int32>

每页显示的设备数。

示例值:10
PageCountinteger<int32>

总页数。

示例值:1
Totalinteger<int32>

设备总数。

示例值:2
Pageinteger<int32>

当前页面号。

示例值:1
Dataobject

返回示例

变更历史

暂无变更历史

相关示例

Iot删除设备
2021-01-15
查询IOT设备的运行状态、影子信息
2021-02-28
一型一密免注册功能
2022-07-06