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

接口说明

限制说明

  • 目前仅华东 2(上海)地域下,企业版实例和新版公共实例,支持动态分组功能。实例详细说明,请参见实例管理

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

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

流控信息

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

授权信息

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

具体说明如下:展开详情

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

请求参数

字段名称字段详情
IotInstanceIdstring

实例 ID。展开详情

示例值:iot-***-v6***
GroupIdstring

分组 ID,分组的全局唯一标识符。展开详情

示例值:tDQvBJqbUyHs***参考取值来源:
    CreateDeviceGroup
PageSizeinteger<int32>

每页记录数,最大值是 200,默认值是 10。

示例值:10
ProductKeystring

设备所属产品的 ProductKey

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

设备名称。展开详情

示例值:light
NextTokenstring

下一页标识,首次查询无需传入。

示例值:TGlzdFJlc291***
CurrentPageinteger<int32>

指定从返回结果中的第几页开始显示。默认值是 1。

示例值:2
Statusstring

设备状态。取值:展开详情

示例值:OFFLINE
FuzzyNameboolean

是否根据 DeviceName 值,模糊搜索设备。展开详情

示例值:true

请求说明

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

返回参数

字段名称字段详情
NextTokenstring

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

示例值:TGlzdFJlc291***
ErrorMessagestring

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

示例值:系统异常
RequestIdstring

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

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

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

示例值:true
Codestring

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

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

每页所显示的设备数量。

示例值:10
Totalinteger<int32>

设备总数。

示例值:24
PageCountinteger<int32>

总页数。

示例值:2
Pageinteger<int32>

当前页码。

示例值:1
Dataobject

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
iot.group.NotExistedGroup
The specified device group does not exist.诊断
400
iot.device.FuzzyRuntimeSearchMinLengthLimit
Fuzzy runtime search length must exceed 4.诊断
400
iot.device.RegionNotSupportDynamicGroup
The region does not currently support the dynamic group feature.诊断
400
iot.common.APINotSupportedInInstance
This API operation is not supported in this instance.诊断

变更历史

暂无变更历史

相关示例

https://iot.console.aliyun.com/groups
2022-09-02