全部產品
Search
文件中心

IoT Platform:UpdateProductTags

更新時間:Feb 12, 2025

調用該介面更新產品標籤。

使用說明

單次調用該介面最多可更新10個標籤。

重要 調用本介面時,必須傳入更新標籤的TagKeyTagValue,否則調用會失敗。參數值請參見本文請求參數表中描述。

QPS限制

單個阿里雲帳號調用該介面的每秒請求數(QPS)最大限制為500。

說明 RAM使用者共用阿里雲帳號配額。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱 類型 是否必選 樣本值 描述
Action String UpdateProductTags

系統規定參數。取值:UpdateProductTags。

ProductKey String a1BwAGV****

產品的ProductKey。ProductKey是物聯網平台為建立產品頒發的通用唯一識別碼。您可以在物聯網平台控制台或調用介面QueryProductList查看當前帳號下所有產品的資訊。

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

執行個體ID。您可在物聯網平台控制台的執行個體概覽頁面,查看當前執行個體的ID

重要
  • 若有ID值,必須傳入該ID值,否則調用會失敗。
  • 若無執行個體概覽頁面或ID值,則無需傳入。

執行個體的更多資訊,請參見執行個體概述

ProductTag.N.TagValue String 202

更新後的標籤值(value)。長度不可超過128字元,可包含中文、英文字母、數字、底線(_)和短劃線(-)。一個中文漢字算2個字元。

ProductTag.N.TagKey String room

產品標籤鍵(key)。長度不可超過30個字元,可包含英文大小寫字母,數字和英文句號(.)。

說明 傳入標籤的TagKey必須是已存在的標籤key。傳入標籤的TagKey不能重複。

調用API時,除了本文介紹的該API的特有請求參數,還需傳入公用請求參數。公用請求參數說明,請參見公用參數文檔

返回資料

名稱 類型 樣本值 描述
Code String iot.system.SystemException

調用失敗時,返回的錯誤碼。更多資訊,請參見錯誤碼

ErrorMessage String 系統異常

調用失敗時,返回的出錯資訊。

InvalidProductTags Array of ProductTag

調用失敗時,返回不合法的產品標籤列表(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=UpdateProductTags
&ProductKey=a1h7knJ****
&ProductTag.1.TagKey=first
&ProductTag.1.TagValue=value1
&ProductTag.2.TagKey=second
&ProductTag.2.TagValue=value2
&<公用請求參數>

正常返回樣本

XML格式

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

JSON格式

{
  "RequestId": "92586B4B-FF78-494A-A22C-368E4293FBB7",
  "Success": true
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。