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

概要

仮想デバイスミラーを修正します。
仮想デバイスミラーが存在しない場合は新規作成され、既に存在している場合には修正されます。

リクエスト

リクエストURL

POST {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

リクエストパラメータ

リクエストボディ

アップデートは、リクエストボディ内のstateに明示されたkeyに対してのみ行われます。
keyに対する値で、nullを入力するとそのkeyが削除されます。
一般的に、1つのリクエストに対し、desiredとreportedとの属性のうち、片一方だけを使用します。

{
    "state" : {
        "desired" : "JSONObject",
        "reported" : "JSONObject"
    },
    "clientToken" : "string",
    "version" : "long"
}

レスポンス

レスポンスボディ

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

例

リクエストボディ

{
    "state": {
        "desired": {
            "id": "abc1",
            "temperature": 33 ,
            "isOn": true
        }
    },
    "clientToken": "ABVS111",
    "version": 4
}

レスポンスボディ

{
    "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
}