Creates a group.

Limits

Each Alibaba Cloud account can run a maximum of 500 queries per second (QPS).

Note RAM users of an Alibaba Cloud account share the quota of the account.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateDeviceGroup

The operation that you want to perform. Set the value to CreateDeviceGroup.

GroupName String Yes grouptest

The name of the group. The alias must be 4 to 30 characters in length, and can contain letters, digits, and underscores (_).

IotInstanceId String No iot_instc_pu****_c*-v64********

The ID of the instance. You can view the instance ID on the Overview page in the IoT Platform console.

Notice
  • If your instance has an ID, you must configure this parameter. If you do not set this parameter, the call fails.
  • If your instance has no Overview page or ID, you do not need to set this parameter.

For more information, see Overview.

SuperGroupId String No SuperGroupId1

The ID of the parent group.

If you need to create a first-level group, do not specify this parameter.

GroupDesc String No Group test

The description of the group. The description must be 1 to 100 characters in length.

In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this operation. For more information, see Common request parameters.

Response parameters

Parameter Type Example Description
Code String iot.system.SystemException

The error code returned if the call fails. For more information, see Error codes.

Data Struct

The group information returned if the call succeeds.

GroupDesc String Group test

The description of each group.

GroupId String HtMLECKbdJQL****

The ID of the group. The ID is the globally unique identifier (GUID) that the system generates for the group.

GroupName String grouptest

The name of the group.

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

The time when the group was created.

ErrorMessage String A system exception occurred.

The error message returned if the call fails.

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

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

  • true: The call was successful.
  • false: The call failed.

Examples

Sample requests

https://iot.cn-shanghai.aliyuncs.com/?Action=CreateDeviceGroup
&GroupDesc=Group test
&GroupName=grouptest
&<Common request parameters>

Sample success responses

XML format 

<CreateDeviceGroupResponse>
      <Data>
            <GroupDesc>Group test</GroupDesc>
            <GroupName>grouptest</GroupName>
            <UtcCreate>2018-10-17T11:19:31.000Z</UtcCreate>
            <GroupId>HtMLECKbdJQL****</GroupId>
      </Data>
      <RequestId>4D6D7F71-1C94-4160-8511-EFF4B8F0634D</RequestId>
      <Success>true</Success>
</CreateDeviceGroupResponse>

JSON format 

{
    "Data":{
        "GroupDesc":"Group test",
        "GroupName":"grouptest",
        "UtcCreate":"2018-10-17T11:19:31.000Z",
        "GroupId":"HtMLECKbdJQL****"
    },
    "RequestId":"4D6D7F71-1C94-4160-8511-EFF4B8F0634D",
    "Success":true
}

Error codes

For a list of error codes, visit the API Error Center.