Method getByName
Статья создана
HTTP request
GET https://iot-devices.api.cloud.yandex.net/iot-devices/v1/devices:getByName
Query parameters
| Parameter | Description |
|---|---|
| registryId | Required. ID of the registry to get device. To get a registry ID make a list request. The maximum string length in characters is 50. |
| deviceName | Required. Name of the device to return. To get a device name make a list request. The maximum string length in characters is 50. Value must match the regular expression [a-zA-Z0-9_-]*. |
| deviceView | Specifies which parts of the device resource should be returned in the response.
|
Response
HTTP Code: 200 - OK
{
"id": "string",
"registryId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"topicAliases": "object",
"status": "string",
"monitoringData": {
"lastAuthIp": "string",
"lastAuthTime": "string",
"lastPubActivityTime": "string",
"lastSubActivityTime": "string",
"lastOnlineTime": "string"
}
}
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 text format. |
| name | string Name of the device. The name is unique within the registry. |
| description | string Description of the device. 0-256 characters long. |
| topicAliases | object 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 | string Status of the device.
|
| monitoringData | object Device monitoring data, returns if FULL view specified. |
| monitoringData. lastAuthIp |
string |
| monitoringData. lastAuthTime |
string (date-time) String in RFC3339 text format. |
| monitoringData. lastPubActivityTime |
string (date-time) String in RFC3339 text format. |
| monitoringData. lastSubActivityTime |
string (date-time) String in RFC3339 text format. |
| monitoringData. lastOnlineTime |
string (date-time) String in RFC3339 text format. |