仮想デバイスの作成

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

概要

仮想デバイスを作成します。

リクエスト

リクエストURL

POST {CLOUD_IOT_CORE_API_URL}/devices

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}

リクエストボディー

{
	"device" : {
        "name": "string",
        "description": "string"
    },
	"deviceProperties":{
		"createUpdateList" : [
            {
                "key": "string",
                "value": "string"
            }
		]
	}
}

項目	必須の有無	タイプ	制約事項	説明
name	Yes	string	128字以内のアルファベットの大文字小文字、数字、-、_のみ許可	仮想デバイス名
description	Yes	string	128文字以内のみ許可 &、<、>、"、' は非許可	仮想デバイスの説明
deviceProperties.createUpdateList[].key	Yes	string	128字以内のアルファベットの大文字小文字、数字、-、_のみ許可	仮想デバイス属性 Key。同一のキーを探して情報を修正します。既存の保存されているキーが要求ボディにない場合は削除されます。
deviceProperties.createUpdateList[].value	No	string	512字以内のアルファベットの大文字小文字、数字、-、_のみ許可	仮想デバイス属性 Value

レスポンス

レスポンスボディ

{
    "status": "string",
    "body": {
        "device": {
            "name": "string",
            "description": "string",
            "modifyTime": "localDateTime",
            "registerTime": "localDateTime"
        },
        "deviceProperties": {
            "createUpdateList": [
                {
                    "key": "string",
                    "value": "string",
                    "modifyTime": "localDateTime",
                    "registerTime": "localDateTime"
                }
            ]
        }
    }
}

項目	タイプ	説明
status	string	レスポンスの成否
body.name	string	仮想デバイス名
body.description	string	仮想デバイス説明
body.modifyTime	localDateTime	仮想デバイスの最終修正日
body.registerTime	localDateTime	仮想デバイスの作成日
body.deviceProperties.createUpdateList[].key	string	仮想デバイス属性 Key
body.deviceProperties.createUpdateList[].value	string	仮想デバイス属性 Value
body.deviceProperties.createUpdateList[].modifyTime	localDateTime	仮想デバイス属性の最終修正日
body.deviceProperties.createUpdateList[].registerTime	localDateTime	仮想デバイス属性の作成日

例

{
    "status": "SUCCESS",
    "body": {
        "device": {
            "name": "bulb",
            "description": "bulb in living room",
            "modifyTime": "2020-09-25 14:15:25",
            "registerTime": "2020-09-25 14:15:25"
        },
        "deviceProperties": {
            "createUpdateList": [
                {
                    "key": "lux",
                    "value": "2000",
                    "modifyTime": "2020-09-25 14:15:25",
                    "registerTime": "2020-09-25 14:15:25"
                },
                {
                    "key": "ampere",
                    "value": "5",
                    "modifyTime": "2020-09-25 14:15:25",
                    "registerTime": "2020-09-25 14:15:25"
                }
            ]
        }
    }
}

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

What's Next

仮想デバイスの大量作成

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

タグ

Cloud IoT Core