CreateDeviceDynamicGroup_物联网平台_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(上海)地域下,企业版实例和新版公共实例,支持创建动态分组。实例详细说明,请参见实例管理

  • 单个阿里云账号下最多可创建 10 个动态分组。

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

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

流控信息

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

授权信息

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

具体说明如下:展开详情

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

请求参数

字段名称字段详情
IotInstanceIdstring

实例 ID。展开详情

示例值:iot-***
GroupDescstring

分组描述。长度不超过 100 个字符,一个中文占一个字符。

示例值:test参考取值来源:
    QueryDeviceGroupList
    CreateDeviceGroup
GroupNamestring

分组名称。名称长度为 4~30 个字符,可包含中文、英文字母、数字和下划线(_)。一个中文占两个字符。

示例值:grouptest参考取值来源:
    CreateConsumerGroup
    QueryConsumerGroupList
DynamicGroupExpressionstring

动态分组规则,用于查询并动态匹配设备到分组。规则表达式编写方法,请参见类 SQL 语法说明

示例值:product_key = "a1***" and name LIKE "test%"参考取值来源:
    QueryDeviceGroupInfo

请求说明

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

返回参数

字段名称字段详情
Codestring

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

示例值:iot.system.SystemException
ErrorMessagestring

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

示例值:系统异常
RequestIdstring

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

示例值:4D6D7F71-1C94-4160-8511-EFF4B8F0634D
Successboolean

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

示例值:true
Dataobject

调用成功时,返回的分组信息。

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
iot.group.DynamicGroupMatchedDeviceCountExceedMax
The maximum number of device matched by dynamic group condition is exceeded.诊断
400
iot.group.GroupCountExceedMax
The number of device groups exceeds the limit.诊断
400
iot.devicesearch.InvalidSQLError
The SQL statement is invalid.诊断
400
iot.devicesearch.InvalidSQLOffsetError
The SQL offset is invalid.诊断
400
iot.devicesearch.InvalidSQLFieldError
The SQL statement contains invalid field names.诊断
400
iot.devicesearch.InvalidSQLConditionError
The SQL statement contains too many conditions.诊断
400
iot.devicesearch.InvalidSQLOrderError
The SQL statement contains invalid ORDER BY conditions.诊断
400
iot.devicesearch.InvalidSQLOperatorTypeError
The operator and data type in the SQL statement do not match.诊断
400
iot.devicesearch.InvalidSQLParamError
The SQL syntax is unsupported.诊断
400
iot.devicesearch.InvalidSQLIdentfierError
The TSL identifier is not configured.诊断
400
iot.group.InvalidGroupName
The specified device group name is invalid.诊断
400
iot.group.LongGroupDescError
The group description exceeds the length limit.诊断
400
iot.group.SuperGroupUnsupport
The super groups do not support subGroups.诊断
400
iot.common.APINotSupportedInInstance
This API operation is not supported in this instance.诊断
400
iot.group.GroupNameExisted
The specified device group name already exists.诊断
400
iot.group.CreateGroupFailed
An error occurred while creating a device group.诊断
400
iot.device.RegionNotSupportDynamicGroup
The region does not currently support the dynamic group feature.诊断
400
MissingDynamicGroupExpression
DynamicGroupExpression is mandatory for this action.诊断
400
iot.databus.SearchIndexConfigNotFound
The search index config is not found.诊断

变更历史

暂无变更历史

相关示例

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