调用该接口为指定产品创建标签。

使用说明

  • 单次调用该接口最多能为指定产品创建10个标签。
  • 单个产品的标签总数不超过100个。
重要 调用本接口时，必须传入标签的TagKey和TagValue，否则调用会失败。参数值请参见本文请求参数表中描述。

QPS限制

单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为500。

说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateProductTags

系统规定参数。取值：CreateProductTags。
ProductKey String 是 a1BwAGV****

产品的ProductKey。ProductKey是物联网平台为新建产品颁发的全局唯一标识符。

您可以在物联网平台控制台或调用接口QueryProductList接口，查看当前账号下所有产品的信息。

IotInstanceId String 否 iot_instc_pu****_c*-v64********

实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。

重要
  • 若有ID值，必须传入该ID值，否则调用会失败。
  • 若无实例概览页面或ID值，则无需传入。

实例的更多信息，请参见实例概述。

ProductTag.N.TagKey String 否 room

产品标签键（Key）。长度不可超过30个字符，可包含英文大小写字母，数字和半角句号（.）。

重要 abc为物联网平台系统保留的标签Key，即标签Key不能设置为abc。若设置Key=abc，使用标签检索时会直接被过滤。
ProductTag.N.TagValue String 否 TagValue

产品标签值（Value）。长度不可超过128字符，可包含中文、英文字母、数字、下划线（_）和短划线（-）。一个中文汉字算2个字符。

调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见公共参数文档。

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时，返回的错误码。更多信息，请参见错误码。

ErrorMessage String 系统异常

调用失败时，返回的出错信息。
InvalidProductTags Array of ProductTag

调用失败时，返回不合法的产品标签列表。
ProductTag
TagKey String room

标签键。
TagValue String 123$

标签值。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云为该请求生成的唯一标识符。
Success Boolean true

表示是否调用成功。

  • true：调用成功，表示产品绑定标签成功。
  • false：调用失败，表示产品绑定标签失败。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=CreateProductTags
&ProductKey=a1h7knJ****
&ProductTag.1.TagKey=first
&ProductTag.1.TagValue=value1
&ProductTag.2.TagKey=second
&ProductTag.2.TagValue=value2
&<公共请求参数>

正常返回示例

XML格式 

<CreateProductTagsResponse>
      <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
      <Success>true</Success>
</CreateProductTagsResponse>

JSON格式 

{
  "RequestId": "354A4F9B-6B01-4498-8084-867F59720BA5",
  "Success": true
}