Method: nodes.devices.list
Stay organized with collections
Save and categorize content based on your preferences.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-12-05 UTC."],[[["\u003cp\u003eLists devices under a specific node or customer within the Spectrum Access System.\u003c/p\u003e\n"],["\u003cp\u003eUses a GET request to retrieve the list of devices, allowing filtering and pagination.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/sasportal\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eProvides details like serial number and display name for each device listed.\u003c/p\u003e\n"],["\u003cp\u003eReturns a comprehensive list of devices based on the specified criteria in the request.\u003c/p\u003e\n"]]],["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"],null,["# Method: nodes.devices.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization Scopes](#body.aspect)\n\nLists [devices](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments.devices#Device) under a [node](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node) or [customer](/spectrum-access-system/reference/rest/v1alpha1/customers#Customer).\n\n### HTTP request\n\n`GET https://sasportal.googleapis.com/v1alpha1/{parent=nodes/*}/devices`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------|\n| `parent` | `string` Required. The name of the parent resource. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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\\]. |\n| `pageToken` | `string` A pagination token returned from a previous call to [devices.list](/spectrum-access-system/reference/rest/v1alpha1/nodes.devices/list#spectrum.sas.portal.v1alpha1.DeviceManager.ListDevices) that indicates where this listing should continue from. |\n| `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. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [ListDevicesResponse](/spectrum-access-system/reference/rest/v1alpha1/ListDevicesResponse).\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/sasportal`"]]
