IoT Core Service, gRPC: DeviceService.Create
Creates a device in the specified registry.
gRPC request
rpc Create (CreateDeviceRequest) returns (operation.Operation)
CreateDeviceRequest
{
"registryId": "string",
"name": "string",
"description": "string",
"certificates": [
{
"certificateData": "string"
}
],
"topicAliases": "string",
"password": "string"
}
Field |
Description |
registryId |
string Required field. ID of the registry to create a device in. To get a registry ID, make a yandex.cloud.iot.devices.v1.RegistryService.List request. |
name |
string Required field. Name of the device. The name must be unique within the registry. |
description |
string Description of the device. |
certificates[] |
Device certificate. |
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. |
password |
string Device password. The password must contain at least three character categories among the following: upper case latin, lower case latin, numbers and special symbols. |
Certificate
Specification of a device certificate.
Field |
Description |
certificateData |
string Public part of the device certificate. |
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"deviceId": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"registryId": "string",
"createdAt": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"topicAliases": "string",
"status": "Status",
"monitoringData": {
"lastAuthIp": "string",
"lastAuthTime": "google.protobuf.Timestamp",
"lastPubActivityTime": "google.protobuf.Timestamp",
"lastSubActivityTime": "google.protobuf.Timestamp",
"lastOnlineTime": "google.protobuf.Timestamp"
}
}
// 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 |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
The time when the Operation resource was last modified. |
done |
bool 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. |
CreateDeviceMetadata
Field |
Description |
deviceId |
string ID of the device that is being created. |
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 |
Creation timestamp. |
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 |
|
lastPubActivityTime |
|
lastSubActivityTime |
|
lastOnlineTime |