Method: nodes.devices.list
HTTP request
GET https://sasportal.googleapis.com/v1alpha1/{parent=nodes/*}/devices
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The name of the parent resource.
|
Query parameters
| Parameters |
pageSize |
integer
The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000].
|
pageToken |
string
A pagination token returned from a previous call to devices.list that indicates where this listing should continue from.
|
filter |
string
The filter expression. The filter should have one of the following formats: "sn=123454" or "displayName=MyDevice". sn corresponds to serial number of the device. The filter is case insensitive.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of ListDevicesResponse.
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/sasportal
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-12-05 UTC.
[null,null,["Last updated 2023-12-05 UTC."],[[["Lists devices under a specific node or customer within the Spectrum Access System."],["Uses a GET request to retrieve the list of devices, allowing filtering and pagination."],["Requires authorization with the `https://www.googleapis.com/auth/sasportal` scope."],["Provides details like serial number and display name for each device listed."],["Returns a comprehensive list of devices based on the specified criteria in the request."]]],["This describes how to list devices under a specified node or customer. The `GET` request is sent to a URL using gRPC Transcoding syntax. The `parent` path parameter is required to identify the node or customer. Optional query parameters include `pageSize` (for limiting results), `pageToken` (for pagination), and `filter` (to search by serial number or display name). The request body is empty, and a successful response returns a `ListDevicesResponse` instance, with the authorization requiring the `sasportal` OAuth scope.\n"]]