IoT Core Service, REST: Device.list
Retrieves the list of devices in the specified registry.
HTTP request
GET https://iot-devices.api.cloud.yandex.net/iot-devices/v1/devices
Query parameters
Parameter | Description |
---|---|
registryId | ID of the registry to list devices in. To get a registry ID make a list request. The maximum string length in characters is 50. |
folderId | ID of the folder to list devices in. To get a folder ID make a list request. The maximum string length in characters is 50. |
pageSize | The maximum number of results per page to return. If the number of available results is larger than Acceptable values are 0 to 1000, inclusive. |
pageToken | Page token. To get the next page of results, set The maximum string length in characters is 100. |
deviceView | Specifies which parts of the device resource should be returned in the response.
|
Response
HTTP Code: 200 - OK
{
"devices": [
{
"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"
}
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
devices[] | object List of devices. |
devices[]. id |
string ID of the device. |
devices[]. registryId |
string ID of the registry that the device belongs to. |
devices[]. createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
devices[]. name |
string Name of the device. The name is unique within the registry. |
devices[]. description |
string Description of the device. 0-256 characters long. |
devices[]. 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. |
devices[]. status |
string Status of the device.
|
devices[]. monitoringData |
object Device monitoring data, returns if FULL view specified. |
devices[]. monitoringData. lastAuthIp |
string |
devices[]. monitoringData. lastAuthTime |
string (date-time) String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
devices[]. monitoringData. lastPubActivityTime |
string (date-time) String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
devices[]. monitoringData. lastSubActivityTime |
string (date-time) String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
devices[]. monitoringData. lastOnlineTime |
string (date-time) String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
nextPageToken | string Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use Each subsequent page will have its own |