裝置標籤 - IoT Platform

裝置的部分資訊，如廠商、裝置型號等，可以作為裝置標籤上報。您也可以查詢、刪除裝置包含的標籤資訊。本文介紹上報、查看和刪除裝置標籤的Topic和資料格式。

上報標籤資訊

上行。

請求Topic：/sys/${productKey}/${deviceName}/thing/deviceinfo/update
響應Topic：/sys/${productKey}/${deviceName}/thing/deviceinfo/update_reply

Alink請求資料格式：

{
    "id": "123",
    "version": "1.0",
    "sys":{
        "ack":0
    },
    "params":[
        {
            "attrKey": "Temperature",
            "attrValue": "36.8"
        }
    ],
    "method": "thing.deviceinfo.update"
}

Alink響應資料格式：

{
    "id": "123",
    "code": 200,
    "data": {}
}

參數說明：

參數	類型	說明
id	String	訊息ID號。String類型的數字，取值範圍0~4294967295，且每個訊息ID在當前裝置中具有唯一性。
version	String	協議版本號碼，目前協議版本號碼唯一取值為1.0。
sys	Object	擴充功能的參數，其下包含各功能欄位。說明使用裝置端SDK開發時，如果未設定擴充功能，則無此參數，相關功能保持預設配置。
ack	Integer	sys下的擴充功能欄位，表示是否返迴響應資料。 1：雲端返迴響應資料。 0：雲端不返迴響應資料。重要該功能配置說明，請參見物模型使用樣本。如果未配置該功能，則無此參數，雲端預設返迴響應資料。
params	Object	請求參數，包含標籤的鍵attrKey和值attrValue。 params元素個數不超過200個。
method	String	要求方法，取值`thing.deviceinfo.update`。
attrKey	String	標籤Key。支援英文字母、數字、底線（_）、短劃線（-）、井號（#）、at（@）、百分比符號（%）、and（&）、星號（*）和點號（.），長度不超過30個字元。
attrValue	String	標籤的值。支援中文、英文字母、數字、日文、底線（_）和短劃線（-）、井號（#）、at（@）、百分比符號（%）、and（&）、英文冒號（:）和點號（.），長度不超過128個字元，一個中文或日文佔2個字元。
code	Integer	結果資訊，200表示成功。

錯誤碼：

錯誤碼	訊息	描述
460	request parameter error	請求參數錯誤。
6100	device not found	裝置不存在。

查詢標籤資訊

重要

單次查詢的標籤數量不能超過10個。
僅支援查詢您自訂的標籤，不支援查詢物聯網平台系統的內部標籤資訊。
查詢標籤資訊時，必須指定待查詢的標籤鍵。若不指定任何標籤鍵，則返回的標籤資料為空白。

上行

請求Topic：/sys/${productKey}/${deviceName}/thing/deviceinfo/get
響應Topic：/sys/${productKey}/${deviceName}/thing/deviceinfo/get_reply

Alink請求資料格式：

{
    "id": "123",
    "version": "1.0",
    "params":{ 
        "attrKeys":["attrKey1", "attrKey2", "attrKey3"]
    },
    "method": "thing.deviceinfo.get"
}

Alink響應資料格式：

{
    "id": "123",
    "code": 200,
    "data": [
        {
            "attrKey1":"v1"
        },
        {
            "attrKey2":"v2"
        },
        {
            "attrKey3":"v3"
        }
    ]
}

參數說明：

參數	類型	說明
id	String	訊息ID號。String類型的數字，取值範圍0~4294967295，且每個訊息ID在當前裝置中具有唯一性。
version	String	協議版本號碼，目前協議版本號碼唯一取值為1.0。
params	Object	請求參數，包含要查詢標籤的標籤鍵列表attrKeys。
attrKeys	JSONArray	標籤鍵列表，包含要查詢的標籤鍵。說明如果某一個標籤鍵不合法，例如標籤鍵重複，查詢結果會返回異常。如果某一個標籤鍵不存在，查詢結果正常返回空資料。裝置標籤的索引值對配置說明，請參見編輯裝置標籤。
method	String	要求方法，取值`thing.deviceinfo.get`。
data	JSONArray	返回的標籤列表資訊，包含查詢的標籤鍵和標籤值。
code	Integer	結果資訊，200表示成功。

錯誤碼：

錯誤碼	訊息	描述
460	request parameter error	請求參數錯誤。例如：attrKeys類型不為JSONArray，標籤鍵為空白、重複或超出最大查詢數量限制（10）。
429	too many requests	請求QPS過高，已被限流。目前單個阿里雲帳號的每秒請求數（QPS）最大限制為50。說明 RAM使用者共用阿里雲帳號配額。

刪除標籤資訊

上行。

請求Topic：/sys/${productKey}/${deviceName}/thing/deviceinfo/delete
響應Topic：/sys/${productKey}/${deviceName}/thing/deviceinfo/delete_reply

Alink請求資料格式：

{
    "id": "123",
    "version": "1.0",
    "sys":{
        "ack":0
    },
    "params": [
        {
            "attrKey": "Temperature"
        }
    ],
    "method": "thing.deviceinfo.delete"
}

Alink響應資料格式：

{
    "id": "123",
    "code": 200,
    "data": {}
}

參數說明：

參數	類型	說明
id	String	訊息ID號。String類型的數字，取值範圍0~4294967295，且每個訊息ID在當前裝置中具有唯一性。
version	String	協議版本號碼，目前協議版本號碼唯一取值為1.0。
sys	Object	擴充功能的參數，其下包含各功能欄位。說明使用裝置端SDK開發時，如果未設定擴充功能，則無此參數，相關功能保持預設配置。
ack	Integer	sys下的擴充功能欄位，表示是否返迴響應資料。 1：雲端返迴響應資料。 0：雲端不返迴響應資料。重要該功能配置說明，請參見物模型使用樣本。如果未配置該功能，則無此參數，雲端預設返迴響應資料。
params	Object	請求參數，包含要刪除的標籤鍵attrKey參數。
method	String	要求方法，取值`thing.deviceinfo.delete`。
attrKey	String	要刪除的標籤鍵。
code	Integer	結果資訊，200表示成功。

錯誤碼：

錯誤碼	訊息	描述
460	request parameter error	請求參數錯誤。
6100	device not found	裝置不存在。