IoT Core Service, gRPC: DeviceService.List

Статья создана

Yandex Cloud

Обновлена 24 апреля 2025 г.

gRPC request
ListDevicesRequest
ListDevicesResponse
Device
DeviceMonitoringData

Retrieves the list of devices in the specified registry.

gRPC request

rpc List (ListDevicesRequest) returns (ListDevicesResponse)

ListDevicesRequest

{
  // Includes only one of the fields `registry_id`, `folder_id`
  "registry_id": "string",
  "folder_id": "string",
  // end of the list of possible fields
  "page_size": "int64",
  "page_token": "string",
  "device_view": "DeviceView"
}

Field	Description
registry_id	string ID of the registry to list devices in. To get a registry ID make a yandex.cloud.iot.devices.v1.RegistryService.List request. Includes only one of the fields `registry_id`, `folder_id`.
folder_id	string ID of the folder to list devices in. To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request. Includes only one of the fields `registry_id`, `folder_id`.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than `page_size`, the service returns a ListDevicesResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100.
page_token	string Page token. To get the next page of results, set `page_token` to the ListDevicesResponse.next_page_token returned by a previous list request.
device_view	enum 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.

ListDevicesResponse

{
  "devices": [
    {
      "id": "string",
      "registry_id": "string",
      "created_at": "google.protobuf.Timestamp",
      "name": "string",
      "description": "string",
      "topic_aliases": "map<string, string>",
      "status": "Status",
      "monitoring_data": {
        "last_auth_ip": "string",
        "last_auth_time": "google.protobuf.Timestamp",
        "last_pub_activity_time": "google.protobuf.Timestamp",
        "last_sub_activity_time": "google.protobuf.Timestamp",
        "last_online_time": "google.protobuf.Timestamp",
        "last_disconnect_time": "google.protobuf.Timestamp"
      },
      "labels": "map<string, string>"
    }
  ],
  "next_page_token": "string"
}

Field

Description

devices[]

Device

List of devices.

next_page_token

string

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

Each subsequent page will have its own next_page_token to continue paging through the results.

Device

A device. For more information, see Device.

Field	Description
id	string ID of the device.
registry_id	string ID of the registry that the device belongs to.
created_at	google.protobuf.Timestamp 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.
topic_aliases	object (map<string, 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. `my/custom/alias` match to `$device/abcdef/events`.
status	enum Status Status of the device. `STATUS_UNSPECIFIED` `CREATING`: Device is being created. `ACTIVE`: Device is ready to use. `DELETING`: Device is being deleted.
monitoring_data	DeviceMonitoringData Device monitoring data, returns if FULL view specified.
labels	object (map<string, string>) Resource labels as `key:value` pairs. Maximum of 64 per resource.

DeviceMonitoringData

Field	Description
last_auth_ip	string
last_auth_time	google.protobuf.Timestamp
last_pub_activity_time	google.protobuf.Timestamp
last_sub_activity_time	google.protobuf.Timestamp
last_online_time	google.protobuf.Timestamp
last_disconnect_time	google.protobuf.Timestamp