Method: nodes.nodes.list
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://sasportal.googleapis.com/v1alpha1/{parent=nodes/*}/nodes
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The parent resource name, for example, "nodes/1".
|
Query parameters
| Parameters |
pageSize |
integer
The maximum number of nodes to return in the response.
|
pageToken |
string
A pagination token returned from a previous call to nodes.list that indicates where this listing should continue from.
|
filter |
string
The filter expression. The filter should have the following format: "DIRECT_CHILDREN" or format: "direct_children". The filter is case insensitive. If empty, then no nodes are filtered.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of ListNodesResponse.
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 nodes with support for filtering by direct children and pagination.\u003c/p\u003e\n"],["\u003cp\u003eThe API requires an HTTP GET request to a specific endpoint with path and optional query parameters.\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\u003eBoth request and response bodies have defined structures, with the request being empty and the response containing a \u003ccode\u003eListNodesResponse\u003c/code\u003e object upon success.\u003c/p\u003e\n"]]],["This document outlines the process for listing nodes via an HTTP GET request to `https://sasportal.googleapis.com/v1alpha1/{parent=nodes/*}/nodes`. Key actions include setting the `parent` path parameter to the resource name, and using optional query parameters like `pageSize`, `pageToken`, and `filter` for managing the response. The request body must be empty. A successful request returns a `ListNodesResponse`, and requires `https://www.googleapis.com/auth/sasportal` OAuth scope.\n"],null,["# Method: nodes.nodes.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 [nodes](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node).\n\n### HTTP request\n\n`GET https://sasportal.googleapis.com/v1alpha1/{parent=nodes/*}/nodes`\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 parent resource name, for example, \"nodes/1\". |\n\n### Query parameters\n\n| Parameters ||\n|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of nodes to return in the response. |\n| `pageToken` | `string` A pagination token returned from a previous call to [nodes.list](/spectrum-access-system/reference/rest/v1alpha1/nodes.nodes/list#spectrum.sas.portal.v1alpha1.DeviceManager.ListNodes) that indicates where this listing should continue from. |\n| `filter` | `string` The filter expression. The filter should have the following format: \"DIRECT_CHILDREN\" or format: \"direct_children\". The filter is case insensitive. If empty, then no nodes are filtered. |\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 [ListNodesResponse](/spectrum-access-system/reference/rest/v1alpha1/ListNodesResponse).\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/sasportal`"]]