Adds, updates, or deletes group tags.

Limits

  • Each group can have a maximum of 100 tags.
  • 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 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. 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.

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

The tag data in the JSON format. Each tag consists of the tagKey and tagValue parameters. You must specify the tagKey and tagValue parameters 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. The 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 need to update an existing tag, specify a new value for the tag. The new value overwrites the previous value.

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

GroupType String No LINK_PLATFORM_DYNAMIC

The type of the group.

If you set the value to LINK_PLATFORM_DYNAMIC, a dynamic group is queried. If you do not specify this parameter, a static group is queried by default.

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.

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

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=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
}

Error codes

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