仮想デバイスミラーの照会

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

概要

仮想デバイスミラーを照会します。

リクエスト

リクエストURL

GET {CLOUD_IOT_CORE_API_URL}/devices/{deviceName}/mirror

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

項目	必須有無	タイプ	説明
deviceName	Yes	string	仮想デバイス名

リクエストパラメータ

パラメータ名	必須有無	タイプ	制約事項	説明
name	No	string		仮想デバイスミラー名(nullの場合、デフォルトミラーで動作します)

リクエストボディ

{
    "clientToken" : "string"
}

項目	必須	タイプ	説明	制限事項
clientToken	No	string	clientTokenを持たせてリクエストする場合、レスポンスにそのclientTokenがそのまま表示されます。	最大64Byte

レスポンス

レスポンスボディ

{
    "metadata": {
        "desired" : {
            "key" : {
                "timstamp" : "long"
            }
        },
        "reported" : {
            "key" : {
                "timstamp" : "long"
            }
        }
    },
    "state": {
        "desired": {
            "key": "value"
        },
        "reported": {
            "key": "value"
        }
    },
    "clientToken" : "string",
    "version": "long",
    "timestamp": "long"
}

項目	タイプ	説明
metadata	JSON Object	desired、reported内のkeyがアップデートされた時刻を表現するオブジェクト
metadata.desired.{keyName}.timestamp	timestamp	desired内でこのkeyがアップデートされた時刻
metadata.reported.{keyName}.timestamp	long	reported内でこのkeyがアップデートされた時刻
state	JSON Object	仮想デバイスミラーの状態
state.desired	JSONObject	仮想デバイスミラーにdesiredでリクエストされた状態属性といろいろな値
state.reported	JSONObject	仮想デバイスミラーにreportedで報告された状態属性といろいろな値
clientToken	string	リクエストボディのclientToken
version	long	仮想デバイスミラーのバージョン
timestamp	long	仮想デバイス照会レスポンスが作成された時刻

例

リクエストボディ

{
    "clientToken": "ABVS111"
}

レスポンスボディ

{
    "metadata": {
        "desired": {
            "temperature": {
                "timestamp": 1631097617
            },
            "isOn": {
                "timestamp": 1631097617
            },
            "id": {
                "timestamp": 1631097617
            }
        }
    },
    "clientToken": "ABVS111",
    "state": {
        "desired": {
            "temperature": 33,
            "isOn": true,
            "id": "abc1"
        },
        "reported": {
            "temperature": 35,
            "isOn": false,
            "id": "abc1"
        }
    },
    "version": 5,
    "timestamp": 1631097617
}

この記事は役に立ちましたか?

What's Next

仮想デバイスミラーの修正

概要
リクエスト
レスポンス
例

タグ

Cloud IoT Core