调用该接口创建动态分组。

限制说明

  • 目前仅华东2(上海)地域下,企业版实例和新版公共实例,支持创建动态分组。实例详细说明,请参见实例管理
  • 单个阿里云账号下最多可创建10个动态分组。
  • 单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为1。
    说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateDeviceDynamicGroup

系统规定参数。取值:CreateDeviceDynamicGroup。

DynamicGroupExpression String product_key = "a1***" and name LIKE "test%"

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

GroupName String grouptest

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

IotInstanceId String iot-***

实例ID。

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

GroupDesc String test

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

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

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

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

Data Struct

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

DynamicGroupExpression String product_key = "a1***" and name LIKE "test%"

动态分组规则。

GroupDesc String test

分组描述。

GroupId String HtMLECKbdJQL***

分组ID,系统为分组生成的全局唯一标识符。

GroupName String grouptest

分组名称。

UtcCreate String 2021-10-17T11:19:31.000Z

创建时间。

ErrorMessage String 系统异常

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

RequestId String 4D6D7F71-1C94-4160-8511-EFF4B8F0634D

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

Success Boolean true

表示是否调用成功。

  • true:调用成功。
  • false:调用失败。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateDeviceDynamicGroup
&DynamicGroupExpression=product_key = "a1***" and name LIKE "test%"
&GroupName=grouptest
&IotInstanceId=iot-***
&<公共请求参数>

正常返回示例

XML格式

<CreateDeviceDynamicGroupResponse>
  <RequestId>4D6D7F71-1C94-4160-8511-EFF4B8F0634D</RequestId>
  <Data>
        <GroupName>grouptest</GroupName>
        <UtcCreate>2021-10-17T11:19:31.000Z</UtcCreate>
        <GroupDesc>test</GroupDesc>
        <DynamicGroupExpression>product_key = "a1***" and name LIKE "test%"</DynamicGroupExpression>
        <GroupId>HtMLECKbdJQL***</GroupId>
  </Data>
  <Success>true</Success>
</CreateDeviceDynamicGroupResponse>

JSON格式

{
    "RequestId": "4D6D7F71-1C94-4160-8511-EFF4B8F0634D",
    "Data": {
        "GroupName": "grouptest",
        "UtcCreate": "2021-10-17T11:19:31.000Z",
        "GroupDesc": "test",
        "DynamicGroupExpression": "product_key = \"a1***\" and name LIKE \"test%\"",
        "GroupId": "HtMLECKbdJQL***"
    },
    "Success": true
}