Queries groups to which a device belongs.

Limits

  • You can add a device to a maximum of 10 groups.
  • Each Alibaba Cloud account can run a maximum of 50 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 QueryDeviceGroupByDevice

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

DeviceName String Yes test456

The DeviceName of the device.

ProductKey String Yes a1SKk9K****

The ProductKey of the product to which the device belongs.

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.

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.

ErrorMessage String A system exception occurred.

The error message returned if the call fails.

GroupInfos Array of GroupInfo

The group information returned if the call succeeds. For more information, see the following GroupInfo parameter.

GroupInfo
GroupDesc String father desc

The description of the group.

GroupId String 6a3FF2XE2BKa****

The ID of the group.

GroupName String father1543152336554

The name of the group.

GroupType String LINK_PLATFORM_DYNAMIC

The type of the group.

UtcCreate String 2018-11-25T13:25:37.000Z

The time when the group was created.

RequestId String 7941C8CD-7764-4A94-8CD9-E2762D4A73AC

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=QueryDeviceGroupByDevice
&DeviceName=test456
&ProductKey=a1SKk9K****
&<Common request parameters>

Sample success responses

XML format 

<QueryDeviceGroupByDeviceResponse>
  <RequestId>7941C8CD-7764-4A94-8CD9-E2762D4A73AC</RequestId>
  <GroupInfos>
        <GroupInfo>
              <GroupDesc>father desc</GroupDesc>
              <GroupName>father1543152336554</GroupName>
              <UtcCreate>2018-11-25T13:25:37.000Z</UtcCreate>
              <GroupId>6a3FF2XE2BKa***</GroupId>
              <GroupType>LINK_PLATFORM_DYNAMIC</GroupType>
        </GroupInfo>
  </GroupInfos>
  <Success>true</Success>
</QueryDeviceGroupByDeviceResponse>

JSON format 

{
  "RequestId": "7941C8CD-7764-4A94-8CD9-E2762D4A73AC",
  "GroupInfos": {
    "GroupInfo": [
      {
        "GroupDesc": "father desc",
        "GroupName": "father1543152336554",
        "UtcCreate": "2018-11-25T13:25:37.000Z",
        "GroupId": "6a3FF2XE2BKa***",
        "GroupType":"LINK_PLATFORM_DYNAMIC"
      }
    ]
  },
  "Success": true
}

Error codes

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