すべてのプロダクト
Search

このプロダクト

    :デバイスタグ

    ドキュメントセンター

    :デバイスタグ

    最終更新日:Feb 06, 2024

    ベンダーやデバイスモデルなど、デバイスに関する一部の情報は、デバイスタグとしてIoT Platformに報告できます。 デバイスのタグを照会して削除することもできます。 このトピックでは、デバイスタグの送信、クエリ、および削除に使用されるトピックとデータ形式について説明します。

    タグの送信

    次のトピックは、デバイスがIoT Platformにリクエストを送信し、IoT Platformがデバイスに応答を送信するときに使用されます。

    • リクエストトピック: /sys/${productKey}/${deviceName}/thing/deviceinfo/update
    • レスポンストピック: /sys/${productKey}/${deviceName}/thing/deviceinfo/update_reply

    Alink JSON形式のサンプルリクエスト:

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

    Alink JSON形式のサンプル応答:

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

    パラメーター

    パラメーターデータ型説明
    idStringメッセージの ID 。 有効な値: 0 ~ 4294967295 各メッセージIDは、デバイスに対して一意である必要があります。
    バージョンStringプロトコルのバージョン番号。 値を 1.0 に設定します。

    sys

    オブジェクト

    拡張フィーチャのパラメータ。The parameter for extended features. 値には、各フィーチャのフィールドが含まれます。

    説明

    デバイスSDKを使用してデバイス機能を開発するときに拡張機能が設定されていない場合、このパラメーターは使用できません。 拡張機能はデフォルトの設定を使用します。

    ack

    Integer

    sysパラメーターの拡張機能フィールド。 このフィールドは、IoT Platformが登録要求の応答データを返すかどうかを指定します。 有効な値：

    • 1: IoT Platformは応答データを返します。

    • 0: IoT Platformは応答データを返しません。

    重要

    パラメーターの詳細については、「TSLモデルの使用方法の例」をご参照ください。

    機能が設定されていない場合、このパラメーターは使用できません。 デフォルトでは、IoT Platformは登録リクエストの応答データを返します。

    paramsオブジェクト

    リクエストのパラメーター attrKeyパラメーターはタグキーを指定し、attrValueパラメーターはタグ値を指定します。

    paramsパラメーターには、配列に最大200個の要素を含めることができます。

    メソッドStringリクエスト方式。 値をthing.de viceinfo.updateに設定します。
    attrKeyStringタグのキー。 キーの長さは1 ~ 30文字で、英数字、アンダースコア (_) 、ハイフン (-) 、数字記号 (#) 、位置記号 (@) 、パーセント記号 (%) 、アンパサンド (&) 、アスタリスク (*) 、およびピリオド (.) を使用できます。
    attrValueStringタグの値。 値の長さは1 ~ 128文字で、漢字、文字、数字、日本語、アンダースコア (_) 、ハイフン (-) 、数字記号 (#) 、位置記号 (@) 、パーセント記号 (%) 、アンパサンド (&) 、コロン (:) 、ピリオド (.) を使用できます。 各漢字または日本語文字は2文字を使用します。
    コードIntegerレスポンス内のHTTPステータスコード。 値200は、リクエストが成功したことを示します。

    エラーコード

    エラーコードエラーメッセージ説明
    460request parameter errorリクエストパラメーターが無効な場合に返されるエラーメッセージ。
    6100device not foundデバイスが存在しない場合に返されるエラーメッセージ。

    タグの照会

    重要
    • 一度に最大10個のタグをクエリできます。
    • カスタムタグのみを照会できます。 IoT Platformの内部タグを照会することはできません。
    • 照会するタグのキーを指定する必要があります。 タグキーを指定しない場合、データは返されません。

    次のトピックは、デバイスがIoT Platformにリクエストを送信し、IoT Platformがデバイスに応答を送信するときに使用されます。

    • リクエストトピック: /sys/${productKey}/${deviceName}/thing/deviceinfo/get
    • レスポンストピック: /sys/${productKey}/${deviceName}/thing/deviceinfo/get_reply
    Alink JSON形式のサンプルリクエスト: 
    {
    "id": "123",
    "version"： "1.0"、
    "param": { 
        "attrKeys":["attrKey1", "attrKey2", "attrKey3"]
    },
    "method": "thing.de viceinfo.get"
}
    Alink JSON形式のサンプルレスポンス: 
    {
    "id": "123",
    "code": 200,
    "data": [
        {
            "attrKey1":"v1"
        },
        {
            "attrKey2":"v2"
        },
        {
            "attrKey3":"v3"
        }
    ]
}
    パラメーター
    パラメーターデータ型説明
    idStringメッセージの ID 。 有効な値: 0 ~ 4294967295 各メッセージIDは、デバイスに対して一意である必要があります。
    バージョンStringプロトコルのバージョン番号。 値を 1.0 に設定します。
    paramsオブジェクトリクエストのパラメーター attrKeysパラメーターは、クエリするタグのキーを指定します。
    attrKeysJSONArray照会するタグキー。
    説明
    • 重複するタグキーなど、タグキーが無効な場合は、例外が返されます。
    • タグキーが存在しない場合、データは返されません。
    デバイスのキーと値の形式でタグを指定する方法の詳細については、「デバイスタグの追加」をご参照ください。
    メソッドStringリクエスト方式。 値をthing.de viceinfo.getに設定します。
    データJSONArrayタグのキーと値を含む、タグに関する返された情報。
    コードIntegerレスポンス内のHTTPステータスコード。 値200は、リクエストが成功したことを示します。
    次の表に、エラーコードを示します。
    エラーコードエラーメッセージ説明
    460request parameter errorリクエストパラメーターが無効な場合に返されるエラーメッセージ。

    たとえば、attrKeysパラメーターの値がJSON配列ではない、タグキーが指定されていない、指定されたタグキーが重複している、または指定されたタグキーの数が10を超えている場合などです。

    429too many requests1秒あたりのクエリ数 (QPS) が多すぎるためにスロットリングがトリガーされた場合に返されるエラーメッセージ。
    このAPI操作は、アカウントごとに1秒あたり最大50回呼び出すことができます。
    説明 Alibaba CloudアカウントのRAMユーザーは、アカウントのクォータを共有します。

    タグの削除

    次のトピックは、デバイスがIoT Platformにリクエストを送信し、IoT Platformがデバイスに応答を送信するときに使用されます。

    • リクエストトピック: /sys/${productKey}/${deviceName}/thing/deviceinfo/delete
    • レスポンストピック: /sys/${productKey}/${deviceName}/thing/deviceinfo/delete_reply

    Alink JSON形式のサンプルリクエスト:

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

    Alink JSON形式のサンプル応答:

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

    パラメーター

    パラメーターデータ型説明
    idStringメッセージの ID 。 有効な値: 0 ~ 4294967295 各メッセージIDは、デバイスに対して一意である必要があります。
    バージョンStringプロトコルのバージョン番号。 値を 1.0 に設定します。

    sys

    オブジェクト

    拡張フィーチャのパラメータ。The parameter for extended features. 値には、各フィーチャのフィールドが含まれます。

    説明

    デバイスSDKを使用してデバイス機能を開発するときに拡張機能が設定されていない場合、このパラメーターは使用できません。 拡張機能はデフォルトの設定を使用します。

    ack

    Integer

    sysパラメーターの拡張機能フィールド。 このフィールドは、IoT Platformが登録要求の応答データを返すかどうかを指定します。 有効な値：

    • 1: IoT Platformは応答データを返します。

    • 0: IoT Platformは応答データを返しません。

    重要

    パラメーターの詳細については、「TSLモデルの使用方法の例」をご参照ください。

    機能が設定されていない場合、このパラメーターは使用できません。 デフォルトでは、IoT Platformは登録リクエストの応答データを返します。

    paramsオブジェクトリクエストのパラメーター attrKeyパラメーターは、削除するタグのキーを指定します。
    メソッドStringリクエスト方式。 値をthing.deviceinfo.de leteに設定します。
    attrKeyString削除するタグのキー。
    コードIntegerレスポンス内のHTTPステータスコード。 値200は、リクエストが成功したことを示します。

    エラーコード

    エラーコードエラーメッセージ説明
    460request parameter errorリクエストパラメーターが無効な場合に返されるエラーメッセージ。
    6100device not foundデバイスが存在しない場合に返されるエラーメッセージ。