IoT Core Service, REST: Device.Update
Updates the specified device.
HTTP request
PATCH https://iot-devices.api.cloud.yandex.net/iot-devices/v1/devices/{deviceId}
Path parameters
Field |
Description |
deviceId |
string Required field. ID of the device to update. To get a device ID make a DeviceService.List request. |
Body parameters
{
"updateMask": "string",
"name": "string",
"description": "string",
"topicAliases": "string"
}
Field |
Description |
updateMask |
string (field-mask) A comma-separated names off ALL fields to be updated. If |
name |
string Name of the device. The name must be unique within the registry. |
description |
string Description of the device. |
topicAliases |
string Alias of a device topic. Alias is an alternate name of a device topic assigned by the user. Map alias to canonical topic name prefix, e.g. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"deviceId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"id": "string",
"registryId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"topicAliases": "string",
"status": "string",
"monitoringData": {
"lastAuthIp": "string",
"lastAuthTime": "string",
"lastPubActivityTime": "string",
"lastSubActivityTime": "string",
"lastOnlineTime": "string"
}
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 To work with values in this field, use the APIs described in the |
done |
boolean If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdateDeviceMetadata
Field |
Description |
deviceId |
string ID of the device that is being updated. |
Status
The error result of the operation in case of failure or cancellation.
Field |
Description |
code |
integer (int32) Error code. An enum value of google.rpc.Code |
message |
string An error message. |
details[] |
object A list of messages that carry the error details. |
Device
A device. For more information, see Device.
Field |
Description |
id |
string ID of the device. |
registryId |
string ID of the registry that the device belongs to. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
name |
string Name of the device. The name is unique within the registry. |
description |
string Description of the device. 0-256 characters long. |
topicAliases |
string Alias of a device topic. Alias is an alternate name of a device topic assigned by the user. Map alias to canonical topic name prefix, e.g. |
status |
enum (Status) Status of the device.
|
monitoringData |
Device monitoring data, returns if FULL view specified. |
DeviceMonitoringData
Field |
Description |
lastAuthIp |
string |
lastAuthTime |
string (date-time) String in RFC3339 To work with values in this field, use the APIs described in the |
lastPubActivityTime |
string (date-time) String in RFC3339 To work with values in this field, use the APIs described in the |
lastSubActivityTime |
string (date-time) String in RFC3339 To work with values in this field, use the APIs described in the |
lastOnlineTime |
string (date-time) String in RFC3339 To work with values in this field, use the APIs described in the |