仮想デバイス検索
- 印刷する
- PDF
仮想デバイス検索
- 印刷する
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
概要
仮想デバイスリストを検索します。
リクエスト
リクエスト URL
GET {CLOUD_IOT_CORE_API_URL}/search/devices/name
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}
リクエストパラメーター
| パラメーター名 | 必須の有無 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| page | No | Int | ページ番号。基本値: 0 | |
| size | No | Int | 結果リストのサイズ基本値: 10 | |
| keyword | Yes | string | 検索キーワード |
リクエスト URL
GET {CLOUD_IOT_CORE_API_URL}/search/devices/description
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}
リクエストパラメーター
| パラメーター名 | 必須の有無 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| page | No | Int | ページ番号。基本値: 0 | |
| size | No | Int | 結果リストのサイズ基本値: 10 | |
| keyword | Yes | string | 検索キーワード |
リクエスト URL
GET {CLOUD_IOT_CORE_API_URL}/search/devices/property
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}
リクエストパラメーター
| パラメーター名 | 必須の有無 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| page | No | Int | ページ番号。基本値: 0 | |
| size | No | Int | 結果リストのサイズ基本値: 10 | |
| keyword | Yes | list | コロン(:)、等号(=)、コンマ(,)以外の特殊文字不可 | 検索キーワードリスト (ex) keyword=type=apartment,room:vip |
レスポンス
レスポンスボディ
{
"status": "string",
"body": {
"content": [
{
"device" : {
"name": "string",
"description": "string",
"modifyTime": "localDateTime",
"registerTime": "localDateTime"
},
"deviceProperties" : {
"createUpdateList" : [
{
"key" : "string",
"value" : "string",
"modifyTime": "localDateTime",
"registerTime": "localDateTime"
}
]
}
}
],
"page": {
"size": "long",
"totalElements": "long",
"totalPages": "long",
"number": "long"
}
}
}
| 項目 | タイプ | 説明 |
|---|---|---|
| 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": {
"content": [
{
"device" : {
"name": "bulb",
"description": "small bulb",
"modifyTime": "2019-04-24 19:23:14",
"registerTime": "2019-04-24 19:23:14"
},
"deviceProperties" : {
"createUpdateList" : [
{
"key" : "location",
"value" : "living_room",
"modifyTime": "2019-04-24 19:23:14",
"registerTime": "2019-04-24 19:23:14"
},
{
"key" : "price",
"value" : "10",
"modifyTime": "2019-04-24 19:23:14",
"registerTime": "2019-04-24 19:23:14"
}
]
}
}
],
"page": {
"size": 10,
"totalElements": 1,
"totalPages": 1,
"number": 0
}
}
}
この記事は役に立ちましたか?