調用該接口為指定產品創建標簽。

使用說明

  • 單次調用該接口最多能為指定產品創建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
}