Adds one or more devices to a group.

Limits

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

Note Resource Access Management (RAM) users of an Alibaba Cloud account share the quota of the account.

Debugging

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 BatchAddDeviceGroupRelations

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

Device.N.DeviceName String Yes ZHuPo6sZzv7pOzYh****

The names of devices that you want to add to a group.

Device.N.ProductKey String Yes a1kORrK****

The keys of products to which the devices belong.

GroupId String Yes 6VfhebLg5iUe****

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

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

The instance ID. This parameter is not required for public instances. However, the parameter is required for the instances that you have purchased.

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

Response parameters

Parameter Type Example Description
AlreadyRelatedGroupDeviceCount Integer 0

The number of devices that exist in the group.

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.

ExceedTenGroupDeviceCount Integer 0

The number of the specified devices that are added to 10 or more groups. You can add a device to a maximum of 10 groups.

RequestId String 671D0F8F-FDC7-4B12-93FA-336C079C965A

The ID of the request.

Success Boolean true

Indicates whether the call succeeds.

  • true: The call succeeded.
  • false: The call failed.
SuccessAddedDeviceCount Integer 2

The number of devices that are added to the group.

ValidDeviceCount Integer 2

The number of valid devices that you specify.

Examples

Sample requests

https://iot.cn-shanghai.aliyuncs.com/?Action=BatchAddDeviceGroupRelations
&Device.1.DeviceName=ZHuPo6sZzv7pOzYh****
&Device.1.ProductKey=a1kORrK****
&Device.2.DeviceName=rB4V9PDW2FCPmwuf****
&Device.2.ProductKey=a1kORrK****
&GroupId=6VfhebLg5iUe****
&<Common request parameters>

Sample success responses

XML format

<BatchAddDeviceGroupRelationsResponse>
      <SuccessAddedDeviceCount>2</SuccessAddedDeviceCount>
      <ExceedTenGroupDeviceCount>0</ExceedTenGroupDeviceCount>
      <ErrorMessage>2 devices have been added, and 0 devices failed to be added. </ErrorMessage>
      <ValidDeviceCount>2</ValidDeviceCount>
      <AlreadyRelatedGroupDeviceCount>0</AlreadyRelatedGroupDeviceCount>
      <RequestId>671D0F8F-FDC7-4B12-93FA-336C079C965A</RequestId>
      <Success>true</Success>
</BatchAddDeviceGroupRelationsResponse>

JSON format

{
    "SuccessAddedDeviceCount":2,
    "ExceedTenGroupDeviceCount":0,
    "ErrorMessage":"2 devices have been added, and 0 devices failed to be added.",
    "ValidDeviceCount":2,
    "AlreadyRelatedGroupDeviceCount":0,
    "RequestId":"671D0F8F-FDC7-4B12-93FA-336C079C965A",
    "Success":true   
}

Error codes

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