Подключиться
Yandex IoT Core

Method 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 page_size, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Default value: 100. Acceptable values are 0 to 1000, inclusive.
pageToken Page token. To get the next page of results, set page_token to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.
deviceView Specifies which parts of the device resource should be returned in the response.
  • BASIC: Server responses without monitoring data. The default value.
  • FULL: Server responses with monitoring data.

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

A device. For more information, see Device.
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.
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. my/custom/alias match to $device/abcdef/events.
devices[].
status		 string

Status of the device.

  • CREATING: Device is being created.
  • ACTIVE: Device is ready to use.
  • DELETING: Device is being deleted.
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.
devices[].
monitoringData.
lastPubActivityTime		 string (date-time)

String in RFC3339 text format.
devices[].
monitoringData.
lastSubActivityTime		 string (date-time)

String in RFC3339 text format.
devices[].
monitoringData.
lastOnlineTime		 string (date-time)

String in RFC3339 text format.
nextPageToken string

Token for getting the next page of the list. If the number of results is greater than the specified pageSize, use next_page_token as the value for the pageToken parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.
В этой статье: