Adds, updates, or deletes group tags.

Usage notes

A device group can have a maximum of 100 tags.

QPS limits

Each Alibaba Cloud account can run up to 50 queries per second (QPS).

Note The 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 SetDeviceGroupTags

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

GroupId String Yes W16X8Tvdosec****

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 ID of the instance. On the Overview page in the IoT Platform console, you can view the ID of the instance.

Important
  • If your instance has an ID, you must specify the ID for this parameter. Otherwise, the call fails.
  • If the Overview page or instance ID is not displayed in the IoT Platform console, you do not need to configure this parameter.

For more information about the instance, see Overview.

TagString String No [{"tagKey":"h1","tagValue":"rr"},{"tagKey":"7h","tagValue":"rr"}]

The tag data in the JSON format. The TagString parameter specifies multiple tags in the format of key-value pairs. You must specify tagKey and tagValue for each tag.

  • tagKey: the tag key. The key must be 2 to 30 characters in length, and can contain letters, digits, and periods (.).
  • tagValue: the tag value. Each value can contain letters, digits, underscores (_), and hyphens (-). The value must be 1 to 128 characters in length.

Separate multiple tags with commas (,). Example: [{"tagKey":"h1","tagValue":"rr"},{"tagKey":"7h","tagValue":"rr"}]

If you specify a new value for an existing tag, the new tag value overwrites the original value.

If you want to delete a tag, you do not need to specify the key and value for the tag.

Important abc is a key that is reserved by IoT Platform. You cannot set tagKey to abc. If you set tagKey to abc, the abc tag is automatically filtered when you query tags.
GroupType String No LINK_PLATFORM_DYNAMIC

The type of the group.

You do not need to configure this parameter.

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

Response parameters

Parameter Type Example Description
Code String iot.system.SystemException

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

ErrorMessage String A system exception occurred.

The error message returned if the call fails.

RequestId String 12CFDAF1-99D9-42E0-8C2F-F281DA5E8953

The ID of the request.

Success Boolean true

Indicates whether the call was successful. Valid values:

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

Examples

Sample requests

https://iot.cn-shanghai.aliyuncs.com/?Action=SetDeviceGroupTags
&GroupId=W16X8Tvdosec****
&TagString=[{"tagKey":"h1","tagValue":"rr"},{"tagKey":"7h","tagValue":"rr"}]
&<Common request parameters>

Sample success responses

XML format 

<SetDeviceGroupTagsResponse>
      <RequestId>12CFDAF1-99D9-42E0-8C2F-F281DA5E8953</RequestId>
      <Success>true</Success>
</SetDeviceGroupTagsResponse>

JSON format 

{
    "RequestId":"12CFDAF1-99D9-42E0-8C2F-F281DA5E8953",
    "Success":true
}